4.3 - 二次開發API

GoMinerProxy 的API文檔（v1.1.0版本，如部分新版功能未能更新可瀏覽器F12進行分析）

描述：登錄

請求URL：http://<domain_name>:<port>/api/auth/login

請求方式：POST

參數：

參數名	必選	類型	說明
password	是	string	登錄密碼

返回示例：

{
    "code": 200,
    "expire": "2022-01-01T00:00:00+08:00",
    "token": "**********"
}

返回參數說明：

參數名	類型	說明
code	int	200：為成功；400：為失敗
expire	int64	token過期時間
token	string	Json Web Token，鑒權用

備注：Json Web Token過期時間為1天，超時后需重新登錄獲取

描述：獲取主頁信息

請求URL：http://<domain_name>:<port>/api/pool/dashboard

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "activeProxyCount": ***,
    "minerCount": ***,
    "processedJobs": *******,
    "processedSubmits": *******,
    "startTime": **********,
    "totalHashrate": ********
}

返回參數說明：

參數名	類型	說明
activeProxyCount	int	活躍代理池數
minerCount	int	在線礦機數
processedJobs	int64	已分配任務數
processedSubmits	int64	已提交貢獻數
startTime	int64	時間戳，服務端開啟時間
totalHashrate	int64	總算力(單位H/s)

備注：無

描述：獲取服務器設置信息

請求URL：http://<domain_name>:<port>/api/pool/setting

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "password": "********",
    "version": "*******",
    "webPort": 9998
}

返回參數說明：

參數名	類型	說明
password	string	登錄密碼
version	string	當前服務端版本號
webPort	int	網頁使用的端口

備注：無

描述：獲取公告信息

請求URL：http://<domain_name>:<port>/api/pool/announcement

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "raw": "********"
}

返回參數說明：

參數名	類型	說明
raw	string	markdown格式的公告信息

備注：無

描述：獲取代理池列表

請求URL：http://<domain_name>:<port>/api/pool/proxyList

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

[
    {
        "activeMinerCount": *,
        "name": "************",
        "pool": {
            "domain": "****************",
            "name": "**********"
        },
        "port": *****,
        "running": true
    }
]

返回參數說明：

參數名	類型	說明
activeMinerCount	int	該代理池目前鏈接的礦機數
name	string	該代理池名稱
pool-domain	string	該代理池代理的礦池域名
pool-name	string	該代理池代理的礦池名稱
port	int	該代理池的端口
running	boolean	該代理池的運行狀態

備注：無

描述：獲取可代理的礦池列表

請求URL：http://<domain_name>:<port>/api/pool/upperPeers

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

[
    {
        "domain": "eth.f2pool.com",
        "id": 0,
        "name": "魚池"
    }
]

返回參數說明：

參數名	類型	說明
domain	string	代理的礦池域名
id	int	代理的礦池ID
name	string	代理的礦池名稱

備注：無

描述：獲取代理池配置信息

請求URL：http://<domain_name>:<port>/api/pool/proxy/config?name=<proxy_name>

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "name": "*****",
    "listenPort": ****,
    "poolIndex": *,
    "reconnectDelay": *,
    "feeLogic": *,
    "fees": [
        {
            "loginName": "*************************",
            "workerName": "****",
            "fee": *
        }
    ]
}

返回參數說明：

參數名	類型	說明
name	string	該代理池的名稱
listenPort	int	該代理池的端口
poolIndex	int	上游礦池ID，可以從upperPeer獲取
reconnectDelay	int	抽水延遲，暫未使用，默認0
feeLogic	int	抽水邏輯，1：單礦機平均抽水；3：單礦機隨機抽水
fees-loginName	string	該代理池抽水錢包地址
fees-workerName	string	該代理池抽水礦機名
fees-fee	int	該代理池抽水的比例(單位:千分之一)

備注：無

描述：獲取代理池鏈接的礦機信息

請求URL：http://<domain_name>:<port>/api/pool/proxy/miners?name=<proxy_name>

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

[
    {
        "address": "***.***.***.***:*****",
        "connectTime": **********,
        "feeSubmits": **,
        "hashrate": *******,
        "lastSubmitDelay": *,
        "loginName": "************************",
        "submits": ***,
        "workerName": "***"
    }
]

返回參數說明：

參數名	類型	說明
address	string	礦機的IP地址和端口
connectTime	int64	礦機的連接時間戳
feeSubmits	int64	礦機的抽水份額
hashrate	int64	礦機的算力
lastSubmitDelay	int	提交延遲
loginName	string	礦機錢包地址
submits	int64	礦機的提交份額
workerName	string	礦機名

備注：無

描述：獲取服務器運行日志

請求URL：http://<domain_name>:<port>/api/pool/logs

請求方式：GET

參數：無

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "logs": [
        {
            "message": "*****************************************",
            "prefix": "****",
            "time": *********,
            "type": 0
        }
    ]
}

返回參數說明：

參數名	類型	說明
message	string	一行日志的具體信息
prefix	string	一行日志的關鍵程度
time	int64	一行日志的時間戳
type	int	一行日志的類型

備注：無

描述：創建代理池

請求URL：http://<domain_name>:<port>/api/pool/proxy/create

請求方式：POST

請求示例：

{
    "feeLogic": 3,
    "fees": [
        {
            "fee": 15,
            "loginName": "gominerproxy",
            "workerName": "test"
        }
    ],
    "listenPort": 60004,
    "name": "test",
    "poolIndex": 0,
    "reconnectDelay": 0
}

參數：

參數名	必選	類型	說明
feeLogic	是	string	抽水邏輯，1：單礦機平均抽水；3：單礦機隨機抽水
fees-fee	否	int	該代理池抽水的比例(單位:千分之一)
fees-loginName	否	string	該代理池抽水錢包地址
fees-workerName	否	string	該代理池抽水礦機名
listenPort	是	int	該代理池的端口
name	是	string	該代理池的名稱
poolIndex	是	int	上游礦池ID，可以從upperPeer獲取
reconnectDelay	是	int	抽水延遲，暫未使用，默認0

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回參數說明：

參數名	類型	說明
code	int	0：成功；1：失敗
error	string	錯誤原因

備注：無

描述：刪除代理池

請求URL：http://<domain_name>:<port>/api/pool/proxy/delete?name=<proxy_name>

請求方式：POST

請求示例：

{
    "name": "test"
}

參數：

參數名	必選	類型	說明
name	是	string	該代理池的名稱

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回參數說明：

參數名	類型	說明
code	int	0：成功；1：失敗
error	string	錯誤原因

備注：無

描述：啟動代理池

請求URL：http://<domain_name>:<port>/api/pool/proxy/start?name=<proxy_name>

請求方式：POST

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回參數說明：

參數名	類型	說明
code	int	0：成功；1：失敗
error	string	錯誤原因

備注：無

描述：停止代理池

請求URL：http://<domain_name>:<port>/api/pool/proxy/stop?name=<proxy_name>

請求方式：POST

Header：可以參考https://learning.postman.com/docs/sending-requests/authorization/#bearer-token

參數名	必選	類型	說明
Authorization	是	string	登錄時獲取的token，填寫：Bearer[空格]Token

返回示例：

{
    "code": 0,
    "error": null
}

返回參數說明：

參數名	類型	說明
code	int	0：成功；1：失敗
error	string	錯誤原因

備注：無

4.3 - 二次開發API

4.3 - 二次開發API

results matching ""

No results matching ""